Package com.cisco.pt.ptmp
Interface PacketTracerReadWorker
- All Known Implementing Classes:
PacketTracerReadWorkerImpl
public interface PacketTracerReadWorker
Provides a thread to read response messages and asynchronous (out-of-band) event
messages sent by Packet Tracer.
- Author:
- packettracerexapps@external.cisco.com
-
Method Summary
Modifier and TypeMethodDescriptionReturns the pipeline used for readinggetResponse(LTV ltv) Blocks the current Thread until a response message for ltv is received from Packet TracervoidregisterRequest(LTV ltv) Creates an entry that will be matched with any response to the ltv from Packet TracervoidCauses this worker to stop running.voidstart()Causes this worker to start running.
-
Method Details
-
getPipeline
Pipeline getPipeline()Returns the pipeline used for reading- Returns:
- The underlying pipeline
-
registerRequest
Creates an entry that will be matched with any response to the ltv from Packet Tracer- Parameters:
ltv- A message being sent that will generate a response from Packet Tracer
-
getResponse
Blocks the current Thread until a response message for ltv is received from Packet Tracer- Parameters:
ltv- The message whose response is desired- Returns:
- the response LTV received from Packet Tracer
-
start
void start()Causes this worker to start running. -
shouldStop
void shouldStop()Causes this worker to stop running. This may take effect immediately, or after an unspecified delay.
-